Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: some hacks to get rid of warnings #11257

Merged
merged 3 commits into from
Oct 7, 2015

Conversation

jorisvandenbossche
Copy link
Member

This PR includes some hacks to numpydoc to get rid of a bunch of warnings (split of from #11069 as I want these merged for 0.17.0). There is some more explanation in the commit messages.

Closes #6100

The disadvantage of this is that this causes a deviation from numpydoc upstream, and makes it more difficult to update to that one.

…g members)

The Categorical docstring in api.rst uses a seperate template to not
include an autosummary table with toctrees of all members. But
numpydoc still includes a list by default (which will gives thousands of
warnings). This hack ensures that for Categorical class docstring this
list is not included.
See GH6100. Some attributes of our classes are None, even on the
class objects themselves (so not on instances). By default, numpydoc
does not include them in the autosummary table but in a separate
plain table. But, our class.rst template does include them in the
toctree autosummary, which creates docstring pages for these. This
results in warnings "WARNING: document isn't included in any toctree".
This hack to numpydoc does include them in the autosummary in the class
docstring, removing this warning.
@jorisvandenbossche jorisvandenbossche added this to the 0.17.0 milestone Oct 7, 2015
@jreback
Copy link
Contributor

jreback commented Oct 7, 2015

squash / merge when ready

@jorisvandenbossche
Copy link
Member Author

I would like to not squash the HACKs, as it are separate changes with separate explanations in the commit messages, and so it is more easy to see what we exactly changes and more easy to revert them separately if things change in numpydoc.

jorisvandenbossche added a commit that referenced this pull request Oct 7, 2015
DOC: some hacks to get rid of warnings
@jorisvandenbossche jorisvandenbossche merged commit 72f500d into pandas-dev:master Oct 7, 2015
@jreback
Copy link
Contributor

jreback commented Oct 7, 2015

sure no prob

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants